Vcenter Guest Ipv4

The Vcenter Guest Ipv4 schema specifies the IPv4 settings that need to be applied to a virtual network adapter.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "type": "string",
    "ip_address": "string",
    "prefix": 0,
    "gateways": [
        "string"
    ]
}

string

type

Required

The type of the IPv4 configuration.

For more information see: Vcenter Guest Ipv4 Type.

This property was added in vSphere API 7.0.0.0.

string

ip_address

Optional

The static IPv4 address

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter Guest Ipv4 Type.STATIC.

integer As int64 As int64

prefix

Optional

The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion.

This property was added in vSphere API 7.0.0.0.

This property is optional and it is only relevant when the value of type is Vcenter Guest Ipv4 Type.STATIC.

array of string

gateways

Optional

Gateways for the IPv4 address.

This property was added in vSphere API 7.0.0.0.

If missing or null, no gateways are set.